home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 21 / Cream of the Crop 21 (Terry Blount) (October 1996).iso / comm / uudvd05b.zip / MANUAL.TXT < prev    next >
Text File  |  1996-07-10  |  9KB  |  218 lines
  1.  
  2.                             UUDEVIEW FOR DOS MANUAL
  3.                                        
  4.    This file describes both how to use the decoder and how to use the
  5.    encoder.
  6.    
  7. Decoding with UUDeview
  8.  
  9.   Before you can begin Decoding
  10.   
  11.    Before you can begin decoding, you must save the newsfiles from your
  12.    newsreader into one or many files. If you don't know how to do this,
  13.    read my article on saving from newsreaders. In the following part, we
  14.    will assume that you have stored the news articles somewhere on disk,
  15.    either in a single file or in multiple files.
  16.    
  17.   Running the Decoder
  18.   
  19.    You simply start the Decoder from the command line ...
  20.  
  21.         uudeview [options] <filename(s)>
  22.  
  23.    If you have multiple files to decode, you can also use wildcards for
  24.    the filename.
  25.    
  26.    The Decoder will immediately start scanning the input files for
  27.    decodable data. During this time, it prints a line of information for
  28.    every part found. This information may look a little weird, but as
  29.    long as everything works well, you can safely ignore these messages.
  30.    One reason why they're in is that you know the program's working. But
  31.    if decoding fails, the messages are a great help in locating the
  32.    problem.
  33.    
  34.    This scanning phase may take a while, especially with large input
  35.    files. Then, a short summary is printed with the files found and their
  36.    parts.
  37.    
  38.    Now, you are presented with all the files that look like they could be
  39.    decoded, one at a time. You can choose individually for each file
  40.    whether to decode it or not. To do so, you can enter the following
  41.    commands:
  42.    
  43.   Decoder Commands
  44.   
  45.    (?)
  46.           gives a short list of all available commands.
  47.           
  48.    (d)
  49.           decodes the file and writes it to disk. Files are always
  50.           written to the directory where you have started uudeview.
  51.           Therefore, you should always start up uudeview from your
  52.           binaries directory (I always change to /tmp). If the file
  53.           already exists on your hard disk, you will be prompted wheter
  54.           you want to overwrite the existing file, or rename the new one.
  55.           
  56.    (y)
  57.           'yes', does exactly the same as (d)
  58.           
  59.    (n)
  60.           Do not decode this file and go to the next file.
  61.           
  62.    (b)
  63.           Step back to the previous file.
  64.           
  65.    (i)
  66.           Show file Info. Prints out the zeroeth part of the file if
  67.           available, or the first part up to the beginning of encoded
  68.           data. Some of the most annoying headers are stripped.
  69.           
  70.    (e)
  71.           Run a shell command. The best part is, you can actually use the
  72.           actual file as part of the command! Simply enter a dollar sign
  73.           '$' where the filename shall appear. If you have qpv installed,
  74.           you can view a picture before decoding by entering "qpv $".
  75.           Note that the shell will not get the actual filename but a
  76.           temporary filename. Using programs that depend on a fixed
  77.           filename extension will fail.
  78.           
  79.    (l)
  80.           will list a text file. You'll get a lot of junk if you try this
  81.           command on anything other than text files.
  82.           
  83.    (r)
  84.           prompts you for an alternate filename. If you later (d)ecode
  85.           the file, it will be written under this new filename. Any
  86.           directory will be stripped from this filename.
  87.           
  88.    (p)
  89.           allows you to change the save path, that is, the directory
  90.           where decoded binaries will be saved to. You can see the
  91.           present path in the command description (which you get with the
  92.           (?) command).
  93.           
  94.    (q)
  95.           quits the program without prompting for all the other files.
  96.           
  97.    (c)
  98.           displays the copyright notice and some other blah.
  99.           
  100.   UUDeview Options
  101.   
  102.    One or more of these options can be given on the command line to
  103.    modify the behaviour of the decoder.
  104.    
  105.    +e
  106.           Describes a set of extensions to be decoded exclusively. You
  107.           must line up the extensions, each one preceded by a dot with no
  108.           space between two extensions.
  109.           +e .jpg.gif instructs the program to ignore postings other than
  110.           jpg or gif pictures. Note that the extension check is case
  111.           sensitive. All this has to change sometimes, because this
  112.           doesn't allow double extensions (like in .tar.gz).
  113.           
  114.    -e
  115.           is the reverse of +e. Here, you can give a set of extensions
  116.           that the program should ignore, with the same limitations as
  117.           above.
  118.           -e .bmp tells the program to process everything but Windows
  119.           Bitmap files.
  120.           Please note that each 'e' option cancels all previous ones.
  121.           Only the last 'e' option is used. Despite their limits, both
  122.           options are quite useful in conjunction with the following one.
  123.           
  124.    -i
  125.           Tells UUDeview to process the files without user interaction.
  126.           That is, all files are decoded to the current directory without
  127.           asking (batch decoding). With the 'e' options, you can direct
  128.           the program not to process some types of files.
  129.           +e .jpg.gif -i automagically decodes all pictures.
  130.           Similarly, '+i' will enable user interaction; but this is
  131.           really not needed because it's the default.
  132.           
  133.    -o
  134.           Instructs the program to overwrite files already there when
  135.           decoding. The default is to prompt the user whether the file
  136.           shall be overwritten, renamed or skipped.
  137.           
  138.    -f
  139.           Uses fast mode for scanning of input files. The program will
  140.           assume that each input file holds at most one article. This
  141.           option breaks decoding of input files with multiple articles.
  142.           Furthermore, incomplete files aren't detected until the
  143.           decoding step.
  144.           
  145.    -t
  146.           Process text messages. Will offer plain-text messages and
  147.           non-encoded parts from MIME messages for "decoding". Since
  148.           these kinds of messages usually don't have a filename
  149.           associated with them, they receive filenames like "0001.txt".
  150.           
  151.    -d
  152.           Sets the desperate mode, in which the program will also process
  153.           incomplete files. This is useful if you are missing the last
  154.           part of a 50-parts posting, but in most cases the
  155.           desperately-decoded files will simply be corrupt and unusable.
  156.           The degree of usefulness of an incomplete file depends on the
  157.           file type.
  158.           In desperate mode, the decoder will also try to detect short
  159.           Base64 files outside of MIME messages. This is normally
  160.           disabled, because these desperate tries to find Base64 encoding
  161.           may cause misdetenction of encoded data, again resulting in
  162.           invalid files.
  163.           
  164.    -p path
  165.           Sets the decoding path, that is, the path, where decoded
  166.           binaries will be saved to. If you use the program
  167.           interactively, you can also set it from within the program.
  168.           
  169. Encoding with UUEnview
  170.  
  171.    This section describes how to encode files with the UUenview utility.
  172.    It's naming as view is probably a bit boasted, since it is a pure
  173.    command line utility that takes filenames from the command line,
  174.    encodes them and finishes.
  175.    
  176.    The files given on the command line are encoded and written into files
  177.    with the same base name as the original file and extensions of .001,
  178.    .002 etc (as many files are used as necessary enforced by the -lines
  179.    option, see below).
  180.    
  181.   UUEnview Options
  182.   
  183.    UUenview has the following command line options:
  184.    
  185.    -v
  186.           Verbously prints everything the program's trying to do.
  187.           
  188.    -u
  189.           Chooses the uuencoding method. This is the default.
  190.           
  191.    -x
  192.           Chooses the xxencoding method.
  193.           
  194.    -b
  195.           Chooses the Base64 encodi